/*
 * Copyright 2007 Matt Jensen
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.jtell.internal;

import org.jtell.EventChannel;
import org.jtell.EventMetadata;
import org.jtell.EventSink;

import java.util.Collection;

/**
 * <p>
 * <code>EventChannelInternal</code> defines the back-end interface to an event channel. It extends the public
 * {@link EventChannel} interface to include methods for interacting with other channels.
 * </p>
 */
public interface EventChannelInternal extends EventChannel
{
    /**
     * <p>
     * Add all registered event sinks matching a given event metadata object to an existing collection. Called by a
     * child channel to allow it to broadcast events to listeners registered with its parent, while honoring ordering
     * information between listeners at all ancestor levels.
     * </p>
     * 
     * @param eventSinks the collection to which adapters are to be added.
     * @param eventMetadata the event metadata.
     */
    void addMatchingEventSinks(Collection<EventSink> eventSinks, EventMetadata eventMetadata);
}
